Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Update converters docstrings #7250

Merged
merged 1 commit into from
Feb 29, 2024
Merged

docs: Update converters docstrings #7250

merged 1 commit into from
Feb 29, 2024

Conversation

silvanocerza
Copy link
Contributor

Related Issues

Proposed Changes:

Update docstring for all converters Components.

How did you test it?

I generated docs locally.

Notes for the reviewer

N/A

Checklist

@silvanocerza silvanocerza added the ignore-for-release-notes PRs with this flag won't be included in the release notes. label Feb 28, 2024
@silvanocerza silvanocerza requested a review from a team as a code owner February 28, 2024 16:01
@silvanocerza silvanocerza self-assigned this Feb 28, 2024
@silvanocerza silvanocerza requested review from vblagoje and removed request for a team February 28, 2024 16:01
@github-actions github-actions bot added 2.x Related to Haystack v2.0 type:documentation Improvements on the docs labels Feb 28, 2024
@coveralls
Copy link
Collaborator

coveralls commented Feb 28, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build 8097451014

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 55 unchanged lines in 6 files lost coverage.
  • Overall coverage remained the same at 89.905%
Files with Coverage Reduction New Missed Lines %
components/converters/tika.py 2 91.18%
components/converters/txt.py 2 90.0%
components/converters/pypdf.py 4 90.2%
components/converters/azure.py 5 91.53%
components/converters/markdown.py 16 40.0%
components/converters/openapi_functions.py 26 73.85%
Totals Coverage Status
Change from base Build 8097414130: 0.0%
Covered Lines: 5281
Relevant Lines: 5874
💛 - Coveralls

@silvanocerza silvanocerza mentioned this pull request Feb 29, 2024
Merged
@silvanocerza silvanocerza force-pushed the converters-docstrings branch 2 times, most recently from c188e3b to 2c8ee8e Compare February 29, 2024 14:04
vblagoje
vblagoje approved these changes Feb 29, 2024
View reviewed changes
Copy link
Member

@vblagoje vblagoje left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@silvanocerza silvanocerza merged commit 4065a75 into main Feb 29, 2024
20 checks passed
@silvanocerza silvanocerza deleted the converters-docstrings branch February 29, 2024 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vblagoje vblagoje vblagoje approved these changes

Assignees

@silvanocerza silvanocerza

Labels
2.x Related to Haystack v2.0 ignore-for-release-notes PRs with this flag won't be included in the release notes. type:documentation Improvements on the docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docstrings - haystack.components.converters
3 participants
@silvanocerza @coveralls @vblagoje